GobiImageMgmtAPI.h

/*===========================================================================
FILE: 
   GobiImageMgmtAPI.h

DESCRIPTION:
   QUALCOMM Image Management API for Gobi 3000

Copyright (C) 2011 QUALCOMM Incorporated. All rights reserved.
                   QUALCOMM Proprietary/GTDR

All data and information contained in or disclosed by this document is
confidential and proprietary information of QUALCOMM Incorporated and all
rights therein are expressly reserved.  By accepting this material the
recipient agrees that this material and the information contained therein
is held in confidence and in trust and will not be used, copied, reproduced
in whole or in part, nor its contents revealed in any manner to others
without the express written permission of QUALCOMM Incorporated.
==========================================================================*/

/*=========================================================================*/
// Pragmas
/*=========================================================================*/
#pragma once

//---------------------------------------------------------------------------
// Definitions
//---------------------------------------------------------------------- -----

// The actual Gobi IM API functions are tagged/exported with this
#ifndef IMPORTGOBI
#define IMPORTGOBI extern "C" __declspec( dllimport ) 
#endif

// Calling convention for API
#define GOBIAPI __cdecl

/*=========================================================================*/
// Definitions
/*=========================================================================*/


/*=========================================================================*/
// Structs
/*=========================================================================*/

#ifdef __cplusplus
   extern "C" {
#endif

#define UNIQUE_ID_LEN           16
#define MAX_BUILDID_LEN         255
#define MAX_NO_OF_FW                    5
#define MAX_STORED_IMG                  50
#define MAX_IMG_LIST                    2

typedef struct
{
   BYTE         imageType;
   CHAR         uniqueID[UNIQUE_ID_LEN];
   BYTE         buildIDLen;
   CHAR         buildID[MAX_BUILDID_LEN];
} curFwImageList;

typedef struct
{
    BYTE                numInstances;
    curFwImageList      fwImage[MAX_NO_OF_FW];
} arrFwImageList;

typedef struct
{
        BYTE storageIndex;
        BYTE failureCount;
        BYTE arrUniqueId[16];
        BYTE buildIdLen;
#pragma warning(suppress:4200)
        CHAR szBuildId[];
} imageElement;

typedef struct
{
        BYTE* pImageType;
        BYTE* pMaxImage;
        BYTE* pIndexRunning;
        BYTE* pNumOfImageElement;
        imageElement* pImageElements[MAX_STORED_IMG];//4*50=200 bytes
} storedImageSubList;//200+4*4=216 bytes

typedef struct
{
        BYTE* pNumImageType;
        storedImageSubList ArrImageList[MAX_IMG_LIST];//216*2=432 bytes
} storedImageList;//432+4=436 bytes

#ifdef __cplusplus
   };
#endif

/*=========================================================================*/
// Prototypes
/*=========================================================================*/





IMPORTGOBI ULONG GOBIAPI GetBARMode( ULONG * pBARMode );

/*=========================================================================*/
IMPORTGOBI ULONG GOBIAPI SetBARMode();



IMPORTGOBI ULONG GOBIAPI GetStoredImageInfo( 
   ULONG                      imageInfoSize, 
   BYTE *                     pImageInfo,
   ULONG *                    pMajorVersion, 
   ULONG *                    pMinorVersion,
   ULONG *                    pVersionID,
   CHAR *                     pInfo,
   ULONG *                    pLockID );

IMPORTGOBI ULONG GOBIAPI DeleteStoredImage( 
   ULONG                      imageInfoSize, 
   BYTE *                     pImageInfo );

 // End of GIM group